Commandes relatives au document

closeDoc(...)

closeDoc()

Ferme le document courant sans invite de sauvegarde.

Peut générer NoDocOpenError s'il n'y a pas de document à fermer

docChanged(...)

docChanged(booléen)

Active/désactive l'icône Enregistrer dans la barre d'icônes de Scribus et dans l'élément de menu Enregistrer. Il est utile d'appeler cette procédure lorsque vous changez de document, parce que Scribus ne remarquera pas automatiquement un changement de document en utilisant un script.

getUnit(...)

getUnit() -> nombre entier (constante d'unité de Scribus)

Retourne les unités de mesure du document. La valeur retournée sera une des constantes UNIT_*: UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.

haveDoc(...)

haveDoc() -> booléen

Retourne la valeur true s'il y a un document ouvert.

loadStylesFromFile(...)

loadStylesFromFile("nomFichier")

Charge des styles de paragraphe à partir du document Scribus "nomFichier" dans le document courant.

newDoc(...)

newDoc(taille, marges, orientation, numeroPremierePage, unite, pagesRegard, premierePageGauche) -> booléen

Crée un nouveau document et retourne la valeur True si l'opération réussit. Les paramètres ont la signification suivante :

• taille = un vecteur (largeur, hauteur) décrivant la taille du document. Vous pouvez utiliser des constantes prédéfinies nommées PAPER_<paper_type> c'est-à-dire PAPER_A4 etc.
• marges = un vecteur (gauche, droite, haut, bas) décrivant les marges du document
• orientation = l'orientation de la page - constantes PORTRAIT, LANDSCAPE
• numeroPremierePage = est le numéro de la première page dans le document utilisé pour la numérotation. Même si habituellement vous choisirez la valeur 1, il est utile d'avoir de plus grands chiffres si vous créez un document en plusieurs parties.
• unité = cette valeurs définit les unités de mesure utilisées par le document. Utilisez une constante prédéfinie pour cela, parmi les suivantes: UNIT_INCHES, UNIT_MILLIMETERS, UNIT_PICAS, UNIT_POINTS.
• pagesRegard = FACINGPAGES, NOFACINGPAGES
• premierPageGauche = FIRSTPAGELEFT, FIRSTPAGERIGHT

Les valeurs établies pour la largeur, la hauteur et les marges sont exprimées dans les unités choisies pour le document. Les constantes PAPER_* sont exprimées en points. Si votre document n'est pas défini en points, assurez-vous d'en tenir compte.

exemple: newDoc(PAPER_A4, (10, 10, 20, 20), LANDSCAPE, 1, UNIT_POINTS, FACINGPAGES, FIRSTPAGERIGHT)

openDoc(...)

openDoc("nom")

Ouvre le document "nom".

Peut générer ScribusError si le document ne peut pas être ouvert.

saveDoc(...)

saveDoc()

Enregistre le document ouvert sous son nom courant, et retourne la valeur True si l'opération réussit. Si le document n'a pas déjà été enregistré, le système peut afficher le dialogue interactif Enregistrer sous.Si l'enregistrement échoue, il n'y a actuellement aucun moyen de le savoir.

saveDocAs(...)

saveDocAs("nom")

Enregistre le document courant sous le nouveau "nom" (qui peut être un chemin complet ou relatif).

Peut générer ScribusError si l'enregistrement échoue.

setInfo(...)

saveDocAs("auteur", "info", "description") -> booléen

Établit l'information relative au document. "Auteur", "Info", "Description" sont des chaînes.

setMargins(...)

setMargins(lr, rr, tr, br)

Établit les marges du document, les marges Gauche(lr), Droite(rr), Haut(tr) et Bas(br) sont indiquées dans les unités de mesure du document - voir les constantes UNIT_<type>.

setDocType(...)

setDocType(pagesRegard, premierePageGauche)

Assigne le type de document. Pour obtenir des pages en regard, mettez le premier paramètre à FACINGPAGES; pour désactiver facingPages, utilisez NOFACINGPAGES à la place. Si vous voulez que la première page soit à gauche, mettez le deuxième paramètre à FIRSTPAGELEFT; pour une première page à droite, utilisez FIRSTPAGERIGHT.

setUnit(...)

setUnit(type)

Change l'unité de mesure du document. Les valeurs possibles de l'"unité" sont définies par les constantes UNIT_<type>.

Peut générer ValueError si l'unité passée n'est pas valide.